Skip to content

chore(docs): update AGENTS.md to reflect recent changes - #291

Merged
kodiakhq[bot] merged 1 commit into
mainfrom
claude/zen-goodall-ebaad9
Nov 16, 2026
Merged

kodiakhq[bot] merged 1 commit into
mainfrom
claude/zen-goodall-ebaad9

Conversation

@RedStar071

@RedStar071 RedStar071 commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

🔗 Linked issue

N/A — scheduled weekly AGENTS.md maintenance routine.

🧭 Context

Weekly review of pull requests merged into main in the last 7 days (#280, #282, #283, #284, #285, #286, #287), checking whether AGENTS.md still accurately documents the repo's conventions.

Most of the window's changes already carried their own AGENTS.md updates: #280 (announce workflow) and #288/#285 (opentelemetry dispatch spans, gateway addDispatchWrapper/addDestroyHook moved to module-level WeakMaps) landed with the relevant notes already in place. #282/#284 (the plugin-subcommands-advanced preconditions fix and its older-framework regression test) did not add a note, and the new test establishes a reusable pattern — a second instance of the build-then-exec-in-a-child-process convention the file already documents for plugin-opentelemetry's preload tests — worth calling out so a future agent recognizes and reuses it instead of reinventing it.

📚 Description

Added one bullet to the "Conventions" section, next to the existing plugin-opentelemetry preload-test note, describing plugin-subcommands-advanced's tests/older-framework.test.ts: it reads runPreconditions from the @wolfstar/http-framework namespace at call time (not a named import) so the plugin keeps loading on the parts of its peer range (^3.1.0 || ^5.0.0 || ^6.0.0) that predate framework 6.3.0, and it proves this by building the package with tsdown and exec'ing the output in a child Node process — something vitest's own transform would otherwise mask.

No other gaps found: commands, scripts, the typecheck consumption-test list, and the release/announce flow all still match what's on main.

Key changes

  • AGENTS.md: one new bullet under "Conventions" documenting the plugin-subcommands-advanced older-framework build test as a second instance of the preload-test pattern.

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation change
  • Workflow / CI change

Pre-flight Checklist

  • I have read the Contributing Guidelines (if applicable)
  • My code follows the code style of this project
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the documentation accordingly
  • I added a changeset with pnpm changeset (or pnpm changeset add --empty if no release is needed). See .changeset/README.md.

🤖 AI disclosure: Claude Code was used on this PR. Code written with claude-sonnet-5; PR description written with claude-sonnet-5. AI policy.


Generated by Claude Code

RetriggerView in GreptileConfidence Score: 5/5

This documentation-only change appears safe to merge.

Reviews (1) · Last reviewed commit: "docs: update AGENTS.md to reflect recent..." · Reviewed by Greptile

Notes the build-then-exec test pattern plugin-subcommands-advanced uses
(tests/older-framework.test.ts) to guard its runtime namespace lookup of
runPreconditions, which keeps it working on peer framework releases
before 6.3.0, mirroring plugin-opentelemetry's preload-test convention.
@coldtea-pr-lens

Copy link
Copy Markdown

Note

The title starts with chore(docs):, so PR Lens left this pull request undrawn. Comment @pr-lens draw to draw it

github.comment.notice: false in .github/pr-lens.yml turns this note off

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

The AGENTS.md change itself is accurate, but the PR title and body break two repository rules that need fixing before merge.

Reviewed changes: the single commit adding one bullet to AGENTS.md.

  • New "Conventions" bullet — documents plugin-subcommands-advanced's tests/older-framework.test.ts as a second instance of the build-then-exec child-process test pattern. I checked it against the test, tests/fixtures/*, getRunPreconditions() in src/lib/utils/wiring.ts and the package's peer range. Every claim holds.

⚠️ PR title scope docs is not allowed by the semantic PR check

chore(docs): … uses a scope that isn't in the scopes list of .github/workflows/semantic-pull-requests.yml, so that check will fail. AGENTS.md says to omit the scope when a change isn't tied to one package.

Technical details
# PR title scope

## Affected sites
- PR title `chore(docs): update AGENTS.md to reflect recent changes`
- `.github/workflows/semantic-pull-requests.yml:42-58` — allowed scopes are the package names plus `gateway`, `cache`, `sharder`, `deps`, `release`, `ci`.

## Required outcome
- Title passes the semantic PR check.

## Suggested approach
- Retitle to `chore: update AGENTS.md to reflect recent changes` (no scope). The subject must not start with an uppercase letter.

⚠️ PR body carries an extra "Generated by Claude Code" footer

The body ends with _Generated by [Claude Code](https://claude.ai/code/session_…)_ after the AI disclosure line. AGENTS.md ("AI disclosure") says the disclosure line is the only AI attribution allowed, with no tool footers or session links and nothing after it.

Technical details
# Extra AI attribution in PR body

## Affected sites
- PR body, last lines: the `---` rule and `_Generated by [Claude Code](...)_` line after `> 🤖 AI disclosure: …`.

## Required outcome
- The body contains exactly one disclosure line (the one defined in `AI_POLICY.md#disclosure`) and nothing after it.

## Suggested approach
- Remove the trailing `---` and `_Generated by …_` lines via `gh pr edit`, then re-check the final body.

ℹ️ The new bullet doesn't mention the module-hook shim

The bullet says the loader shows a named import "would fail to link", but not why. The mechanism is tests/fixtures/without-run-preconditions.hooks.mjs, which registers module hooks that serve @wolfstar/http-framework without runPreconditions. Without that, a reader may assume the child process runs against a real older framework. A short clause such as "through a module.register hook shim that strips the export" would close the gap. This is optional.

Pullfrog  | Fix it ➔ | View workflow run | Using claude-sonnet-5-5 | 𝕏

@kodiakhq
kodiakhq Bot merged commit f6f5513 into main Nov 16, 2026
15 of 18 checks passed
@kodiakhq
kodiakhq Bot deleted the claude/zen-goodall-ebaad9 branch November 16, 2026 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants